Skip to content

docs(create-cli): document all CLI options in README#1268

Merged
hanna-skryl merged 1 commit intomainfrom
docs-create-cli
Mar 16, 2026
Merged

docs(create-cli): document all CLI options in README#1268
hanna-skryl merged 1 commit intomainfrom
docs-create-cli

Conversation

@hanna-skryl
Copy link
Collaborator

Document --config-format, --mode, and --ci options that were missing from the README and add a monorepo + CI usage example.

@hanna-skryl hanna-skryl self-assigned this Mar 13, 2026
@github-actions github-actions bot added the 📖 Project documentation improvements or additions to the project documentation label Mar 13, 2026
@nx-cloud
Copy link

nx-cloud bot commented Mar 13, 2026

View your CI Pipeline Execution ↗ for commit 6eadfac

Command Status Duration Result
nx run ci:code-pushup -- merge-diffs --files=/h... ✅ Succeeded 5s View ↗
nx run-many --targets=code-pushup --parallel=fa... ✅ Succeeded 1m 33s View ↗
nx run-many --targets=code-pushup --parallel=fa... ✅ Succeeded 13m 40s View ↗
nx run-many -t unit-test,int-test ✅ Succeeded 2m 8s View ↗

☁️ Nx Cloud last updated this comment at 2026-03-16 15:07:36 UTC

@pkg-pr-new
Copy link

pkg-pr-new bot commented Mar 13, 2026

Open in StackBlitz

@code-pushup/ci

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/ci@1268

@code-pushup/cli

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/cli@1268

@code-pushup/core

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/core@1268

@code-pushup/create-cli

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/create-cli@1268

@code-pushup/models

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/models@1268

@code-pushup/nx-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/nx-plugin@1268

@code-pushup/coverage-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/coverage-plugin@1268

@code-pushup/axe-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/axe-plugin@1268

@code-pushup/eslint-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/eslint-plugin@1268

@code-pushup/js-packages-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/js-packages-plugin@1268

@code-pushup/jsdocs-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/jsdocs-plugin@1268

@code-pushup/lighthouse-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/lighthouse-plugin@1268

@code-pushup/typescript-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/typescript-plugin@1268

@code-pushup/utils

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/utils@1268

commit: 6eadfac

@hanna-skryl hanna-skryl marked this pull request as ready for review March 13, 2026 22:55
@github-actions
Copy link
Contributor

github-actions bot commented Mar 13, 2026

Code PushUp

🤨 Code PushUp report has both improvements and regressions – compared current commit 3a925f3 with previous commit d13cc6e.

🕵️ See full comparison in Code PushUp portal 🔍

🏷️ Categories

🏷️ Category ⭐ Previous score ⭐ Current score 🔄 Score change
Updates 🟡 73 🟡 72 ↓ −0.4
Performance 🔴 35 🔴 35 ↓ −0.2
Bug prevention 🟡 75 🟡 75 ↓ −0.1
Documentation 🟡 52 🟡 52 ↓ −0.1
Axe Accessibility 🟡 88 🟡 88 ↓ −0.1
Code style 🟢 100 🟢 100
Code coverage 🟢 92 🟢 92
Security 🔴 0 🔴 0
Type Safety 🟡 67 🟡 67
Miscellaneous 🟡 67 🟡 67
Accessibility 🟢 92 🟢 92
Best Practices 🟢 100 🟢 100
SEO 🟢 92 🟢 92
👎 3 groups regressed, 👍 4 audits improved, 👎 3 audits regressed, 15 audits changed without impacting score

🗃️ Groups

🔌 Plugin 🗃️ Group ⭐ Previous score ⭐ Current score 🔄 Score change
JS packages npm outdated dependencies 🟡 73 🟡 72 ↓ −0.4
Lighthouse Performance 🔴 35 🔴 35 ↓ −0.2
JSDocs coverage Documentation coverage 🟡 52 🟡 52 ↓ −0.1

31 other groups are unchanged.

🛡️ Audits

🔌 Plugin 🛡️ Audit 📏 Previous value 📏 Current value 🔄 Value change
Lighthouse Initial server response time was short 🟥 Root document took 740 ms 🟩 Root document took 380 ms ↓ −48.4 %
Lighthouse First Contentful Paint 🟥 3.4 s 🟥 3.1 s ↓ −7.1 %
Lighthouse Total Blocking Time 🟥 2,090 ms 🟥 3,450 ms ↑ +64.9 %
Lighthouse Speed Index 🟥 6.4 s 🟥 6.1 s ↓ −5.8 %
JS packages Outdated npm dev dependencies. 🟨 61 outdated package versions (30 major, 25 minor, 6 patch) 🟨 61 outdated package versions (32 major, 24 minor, 5 patch)  +0 %
Lighthouse Max Potential First Input Delay 🟥 660 ms 🟥 1,280 ms ↑ +95 %
Lighthouse Time to Interactive 🟥 14.6 s 🟥 14.5 s ↓ −0.9 %
Lighthouse Avoids enormous network payloads 🟩 Total size was 2,386 KiB 🟩 Total size was 2,421 KiB ↑ +1.5 %
Lighthouse Minimizes main-thread work 🟥 9.1 s 🟥 14.3 s ↑ +57.4 %
Lighthouse JavaScript execution time 🟥 2.9 s 🟥 4.6 s ↑ +57.7 %
Lighthouse Reduce unused JavaScript 🟥 Potential savings of 322 KiB 🟥 Potential savings of 276 KiB ↓ −56.3 %
Lighthouse Largest Contentful Paint 🟥 13.8 s 🟥 12.8 s ↓ −7.1 %
Lighthouse Remove duplicate modules in JavaScript bundles 🟥 Potential savings of 102 KiB 🟥 Potential savings of 107 KiB ↓ −95.5 %
Lighthouse Server Backend Latencies 🟩 1,320 ms 🟩 1,040 ms ↓ −20.9 %
Lighthouse Uses efficient cache policy on static assets 🟨 31 resources found 🟨 31 resources found ↑ +0.1 %
Lighthouse Metrics 🟩 100% 🟩 100% ↓ −0.9 %
Lighthouse Network Round Trip Times 🟩 50 ms 🟩 10 ms ↓ −80.6 %
Lighthouse Reduce unused CSS 🟥 Potential savings of 111 KiB 🟥 Potential savings of 111 KiB ↓ −8 %
JS packages Vulnerabilities for npm prod dependencies. 🟥 18 vulnerabilities (2 critical, 6 high, 3 moderate, 7 low) 🟥 19 vulnerabilities (2 critical, 7 high, 3 moderate, 7 low) ↑ +5.6 %
JS packages Vulnerabilities for npm dev dependencies. 🟥 72 vulnerabilities (3 critical, 40 high, 22 moderate, 7 low) 🟥 73 vulnerabilities (3 critical, 41 high, 22 moderate, 7 low) ↑ +1.4 %
Lighthouse Avoids an excessive DOM size 🟥 2,341 elements 🟥 2,340 elements ↓ −0.1 %
Lighthouse Cumulative Layout Shift 🟩 0 🟩 0.001 ↑ +630.5 %

656 other audits are unchanged.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 13, 2026

Code PushUp

😐 Code PushUp report is unchanged – compared current commit 3a925f3 with previous commit d13cc6e.


All of 14 projects are unchanged.

@hanna-skryl hanna-skryl requested a review from matejchalk March 16, 2026 13:57
@hanna-skryl hanna-skryl merged commit 9a288ee into main Mar 16, 2026
24 checks passed
@hanna-skryl hanna-skryl deleted the docs-create-cli branch March 16, 2026 15:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📖 Project documentation improvements or additions to the project documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants